Product
Introducing License Enforcement in Socket
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
@mdit-vue/plugin-component
Advanced tools
A markdown-it plugin to allow vue components in markdown
A markdown-it plugin to allow Vue components in markdown.
@
directive on native HTML tags.npm i @mdit-vue/plugin-component
This plugin will only take effects when the html
option of markdown-it is enabled:
import { componentPlugin } from '@mdit-vue/plugin-component';
import MarkdownIt from 'markdown-it';
const md = MarkdownIt({ html: true }).use(componentPlugin, {
// options
});
const rendered = md.render(
`\
<!-- @ shorthand is supported -->
<Foo @click="onClick" />
<!-- multi-line syntax won't be wrapped with <p> -->
<Foo
class="foo"
:bar="bar"
/>
`,
);
Type: string[]
Default: []
Details:
Extra tags to be treated as block tags.
By default, all standard HTML inline elements will be treated as inline tags (excluding Vue built-in special elements). All unknown elements will be assumed as Vue components, and will be treated as block tags (with slight differences).
In some cases (should be rare though) you might want to force some tags to behave like block tags, then you can use this option to specify the tag names.
Notice that this option is case-sensitive, and has higher priority than the inlineTags option.
Type: string[]
Default: []
Details:
Extra tags to be treated as inline tags.
By default, only standard HTML inline elements will be treated as inline tags (excluding Vue built-in special elements). All unknown elements will be assumed as Vue components, and will be treated as block tags (with slight differences).
Treating Vue components like block tags would work as expected in most cases. However, in some cases you might want to force some tags to behave like inline tags, then you can use this option to specify the tag names.
Notice that this option is case-sensitive, and has lower priority than the blockTags option.
2.1.3 (2024-05-13)
Note: Version bump only for package @mdit-vue/monorepo
FAQs
A markdown-it plugin to allow vue components in markdown
We found that @mdit-vue/plugin-component demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
Product
We're launching a new set of license analysis and compliance features for analyzing, managing, and complying with licenses across a range of supported languages and ecosystems.
Product
We're excited to introduce Socket Optimize, a powerful CLI command to secure open source dependencies with tested, optimized package overrides.